GET api/account/holdingtransactions?clientID={clientID}&adviserID={adviserID}&licenseeID={licenseeID}&codes[0]={codes[0]}&codes[1]={codes[1]}&startDate={startDate}&endDate={endDate}

Get holding transaction history. Transaction data is limited to a 180 day range.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientID

Client ID to filter on.

integer

None.

adviserID

Adviser ID to filter on.

integer

None.

licenseeID

Licensee ID to filter on.

integer

None.

codes

Security codes to filter on.

Collection of string

None.

startDate

Start date range (UTC).

date

None.

endDate

End date range (UTC).

date

None.

Body Parameters

None.

Response Information

Resource Description

Portfolio holding transactions grouped by client account.

Collection of ClientHoldingTransaction
NameDescriptionTypeAdditional information
ClientID

Unique client identifier.

integer

None.

Holdings

Collection of ClientHolding

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ClientID": 1234,
    "Holdings": [
      {
        "SecurityCode": "BHP",
        "Transactions": [
          {
            "TransactionID": 1000,
            "Quantity": 3344.0,
            "CostValue": 2.25,
            "EntryType": 9,
            "Description": "Transferred in",
            "EntryTimestamp": "2024-09-29T14:49:38.5669639+10:00",
            "TransactionRef": "123456789ABCD100"
          },
          {
            "TransactionID": 1000,
            "Quantity": 500.0,
            "CostValue": 6.55,
            "EntryType": 2,
            "Description": "Sell stock",
            "EntryTimestamp": "2024-09-29T14:49:38.5669639+10:00",
            "TransactionRef": ""
          }
        ]
      },
      {
        "SecurityCode": "CBA",
        "Transactions": [
          {
            "TransactionID": 1000,
            "Quantity": 3344.0,
            "CostValue": 2.25,
            "EntryType": 9,
            "Description": "Transferred in",
            "EntryTimestamp": "2024-09-29T14:49:38.5669639+10:00",
            "TransactionRef": "123456789ABCD100"
          },
          {
            "TransactionID": 1000,
            "Quantity": 500.0,
            "CostValue": 6.55,
            "EntryType": 2,
            "Description": "Sell stock",
            "EntryTimestamp": "2024-09-29T14:49:38.5669639+10:00",
            "TransactionRef": ""
          }
        ]
      }
    ]
  },
  {
    "ClientID": 5678,
    "Holdings": [
      {
        "SecurityCode": "BHP",
        "Transactions": [
          {
            "TransactionID": 1000,
            "Quantity": 3344.0,
            "CostValue": 2.25,
            "EntryType": 9,
            "Description": "Transferred in",
            "EntryTimestamp": "2024-09-29T14:49:38.5669639+10:00",
            "TransactionRef": "123456789ABCD100"
          },
          {
            "TransactionID": 1000,
            "Quantity": 500.0,
            "CostValue": 6.55,
            "EntryType": 2,
            "Description": "Sell stock",
            "EntryTimestamp": "2024-09-29T14:49:38.5669639+10:00",
            "TransactionRef": ""
          }
        ]
      },
      {
        "SecurityCode": "CBA",
        "Transactions": [
          {
            "TransactionID": 1000,
            "Quantity": 3344.0,
            "CostValue": 2.25,
            "EntryType": 9,
            "Description": "Transferred in",
            "EntryTimestamp": "2024-09-29T14:49:38.5669639+10:00",
            "TransactionRef": "123456789ABCD100"
          },
          {
            "TransactionID": 1000,
            "Quantity": 500.0,
            "CostValue": 6.55,
            "EntryType": 2,
            "Description": "Sell stock",
            "EntryTimestamp": "2024-09-29T14:49:38.5669639+10:00",
            "TransactionRef": ""
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfClientHoldingTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Portfolio">
  <ClientHoldingTransaction>
    <ClientID>1234</ClientID>
    <Holdings>
      <ClientHolding>
        <SecurityCode>BHP</SecurityCode>
        <Transactions>
          <HoldingTransaction>
            <CostValue>2.25</CostValue>
            <Description>Transferred in</Description>
            <EntryTimestamp>2024-09-29T14:49:38.5669639+10:00</EntryTimestamp>
            <EntryType>SecurityChanged</EntryType>
            <Quantity>3344</Quantity>
            <TransactionID>1000</TransactionID>
            <TransactionRef>123456789ABCD100</TransactionRef>
          </HoldingTransaction>
          <HoldingTransaction>
            <CostValue>6.55</CostValue>
            <Description>Sell stock</Description>
            <EntryTimestamp>2024-09-29T14:49:38.5669639+10:00</EntryTimestamp>
            <EntryType>Sell</EntryType>
            <Quantity>500</Quantity>
            <TransactionID>1000</TransactionID>
            <TransactionRef></TransactionRef>
          </HoldingTransaction>
        </Transactions>
      </ClientHolding>
      <ClientHolding>
        <SecurityCode>CBA</SecurityCode>
        <Transactions>
          <HoldingTransaction>
            <CostValue>2.25</CostValue>
            <Description>Transferred in</Description>
            <EntryTimestamp>2024-09-29T14:49:38.5669639+10:00</EntryTimestamp>
            <EntryType>SecurityChanged</EntryType>
            <Quantity>3344</Quantity>
            <TransactionID>1000</TransactionID>
            <TransactionRef>123456789ABCD100</TransactionRef>
          </HoldingTransaction>
          <HoldingTransaction>
            <CostValue>6.55</CostValue>
            <Description>Sell stock</Description>
            <EntryTimestamp>2024-09-29T14:49:38.5669639+10:00</EntryTimestamp>
            <EntryType>Sell</EntryType>
            <Quantity>500</Quantity>
            <TransactionID>1000</TransactionID>
            <TransactionRef></TransactionRef>
          </HoldingTransaction>
        </Transactions>
      </ClientHolding>
    </Holdings>
  </ClientHoldingTransaction>
  <ClientHoldingTransaction>
    <ClientID>5678</ClientID>
    <Holdings>
      <ClientHolding>
        <SecurityCode>BHP</SecurityCode>
        <Transactions>
          <HoldingTransaction>
            <CostValue>2.25</CostValue>
            <Description>Transferred in</Description>
            <EntryTimestamp>2024-09-29T14:49:38.5669639+10:00</EntryTimestamp>
            <EntryType>SecurityChanged</EntryType>
            <Quantity>3344</Quantity>
            <TransactionID>1000</TransactionID>
            <TransactionRef>123456789ABCD100</TransactionRef>
          </HoldingTransaction>
          <HoldingTransaction>
            <CostValue>6.55</CostValue>
            <Description>Sell stock</Description>
            <EntryTimestamp>2024-09-29T14:49:38.5669639+10:00</EntryTimestamp>
            <EntryType>Sell</EntryType>
            <Quantity>500</Quantity>
            <TransactionID>1000</TransactionID>
            <TransactionRef></TransactionRef>
          </HoldingTransaction>
        </Transactions>
      </ClientHolding>
      <ClientHolding>
        <SecurityCode>CBA</SecurityCode>
        <Transactions>
          <HoldingTransaction>
            <CostValue>2.25</CostValue>
            <Description>Transferred in</Description>
            <EntryTimestamp>2024-09-29T14:49:38.5669639+10:00</EntryTimestamp>
            <EntryType>SecurityChanged</EntryType>
            <Quantity>3344</Quantity>
            <TransactionID>1000</TransactionID>
            <TransactionRef>123456789ABCD100</TransactionRef>
          </HoldingTransaction>
          <HoldingTransaction>
            <CostValue>6.55</CostValue>
            <Description>Sell stock</Description>
            <EntryTimestamp>2024-09-29T14:49:38.5669639+10:00</EntryTimestamp>
            <EntryType>Sell</EntryType>
            <Quantity>500</Quantity>
            <TransactionID>1000</TransactionID>
            <TransactionRef></TransactionRef>
          </HoldingTransaction>
        </Transactions>
      </ClientHolding>
    </Holdings>
  </ClientHoldingTransaction>
</ArrayOfClientHoldingTransaction>

Error Response Information

Resource Description

Portfolio holding transactions grouped by client account.

string

Error Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>